GetLinkStatus

Inside Macintosh: OpenDoc Class Reference /: Part 1 - Classes and Methods / ODFrame

GetLinkStatus
The GetLinkStatus method returns the link status of this frame.
ODLinkStatus GetLinkStatus ();
return value
The link status of this frame. The return value is one of the following: kODInLinkDestination, kODInLinkSource, or kODNotInLink.

DISCUSSION
The value kODInLinkDestination for the status parameter indicates that the frame is embedded in the destination of a link; the content of this frame is thus supplied by a link. The value kODInLinkSource indicates that the frame is embedded in content that is the source of one or more links, but not in content that is the destination of a link. The value kODNotInLink indicates that the frame is not embedded in any linked content, source or destination.
Your part calls its display frame's GetLinkStatus method to determine if it should allow links to be created to or from the content displayed by this frame. For example, if the link status value is kODInLinkDestination, a link should not be created within this frame.

SEE ALSO
The ODFrame::ChangeLinkStatus method (page 308).
"When to Change Link Status" on page 374 in OpenDoc Programmer's Guide.